home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / hobby / rrtrax.zip / TRAINS.MAN < prev   
Text File  |  1993-01-06  |  18KB  |  375 lines

  1. ============    USING TRAINTRAX (MODEL RAILROADER) CATALOG ============
  2.                        Copyright Doug Scott - 1992
  3.  
  4.  
  5. I.  GENERAL INFORMATION & SYSTEM REQUIREMENTS:
  6.  
  7.     This program will run on any system, using DOS 2.0 or higher and having
  8. a minimum of 512k FREE RAM (640k is recommended).   A hard drive is
  9. recommended, as the performance is greatly improved over using a floppy drive.
  10. Your system CONFIG.SYS file should have the FILES set at a minimum of 30 and
  11. the BUFFERS set at a minimum of 20.  Consult your DOS manual on making this
  12. change (if needed).
  13.  
  14. After running the file "MRR.EXE", you should have the following files:
  15.     TRAINS.man    (The file you are reading now)
  16.     RRTRAX.exe    (the TRAINTRAX program.)
  17.  
  18. The first time you run the TRAINTRAX program (RRTRAX.EXE), it will create
  19. these additional files:
  20.     ROSTER.DAT          ROSTER.K04           ROSTER.MEM     ROADNAME.K01
  21.     ROSTER.K01          ROSTER.K05           SCALE.DAT      RRCAT.DAT
  22.     ROSTER.K02          ROSTER.K06           SCALE.K01      RRCAT.K01
  23.     ROSTER.K03          ROSTER.K07           ROADNAME.DAT
  24.  
  25.     (TOTAL space required for the TRAINTRAX program and related files is
  26. approx 422 K.  This does not include your data files.)
  27.  
  28. At most stages of the program, you will see "F-1 = HELP" in the upper left
  29. hand corner of the form or table on the screen.  If this notice is present,
  30. you can press the F-1 key to access the on-line help for that function.
  31.  
  32. To get out of any option, press the ESCAPE key until you get back to where
  33. you want to be.  Pressing CONTROL and ESCAPE will immediately take you back
  34. to the last menu screen.
  35.  
  36. All printouts are formatted for 8.5 x 11 fanfold (continous) paper.  All
  37. printing routines were tested on a Panasonic 1124 printer in EPSON mode and
  38. should work on most compatible printers.
  39.  
  40.  
  41. II.  STARTING THE MAIN PROGRAM
  42.  
  43. Log onto the drive which contains the program and
  44. type "RRtrax" & press ENTER.
  45.  
  46. On accessing the Main menu screen, you will find the following options:
  47.  
  48.      1)  View/Update EQUIPMENT ROSTER
  49.      2)  View/Update MODEL SCALES
  50.      3)  View/Update CATEGORIES - TYPES
  51.      4)  View/Update ROADNAMES
  52.      5)  Print DELUXE LEVEL ROSTERS
  53.      6)  Print SHAREWARE REGISTRATION (by pressing F-5)
  54.      7)  Exit (by pressing ESCAPE)
  55.  
  56. Option 7 IS self explanatory.  To select options 1 through 5, use the up and
  57. down arrow keys to highlight the option and press enter to select.  (You may
  58. also use the "hot key" method to highlight an option by pressing the first
  59. letter of that option.)  These methods of option selection are used on all
  60. TRAINTRAX menus.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. Option 1 is where most of the database file maintenance is done.  It is
  69. through Viewing the equipment records that you can edit and delete existing
  70. records, or add new records.  When you select this option, a small window
  71. will pop up asking you to select either the STANDARD or DELUXE level of the
  72. program.
  73.  
  74. The STANDARD level is designed for model railroaders who want a simple
  75. system to keep track of their equipment.  For this level, you MUST record
  76. the following information on each piece of model railroad equipment:
  77.      1)  equipment category and type
  78.      2)  the model scale
  79.      3)  the model manufacturer
  80.      4)  the ORIGINAL model name or number
  81.      5)  the model railroad the equipment is lettered for
  82.      6)  the road number assigned to the piece of equipment
  83.  
  84.  
  85. The DELUXE level is designed for the more experienced model railroader who
  86. has an extensive collection or has many expensive models, such as brass
  87. engines.  For the DELUXE level, you MUST enter the same information as for
  88. the STANDARD level. The following fields are optional:
  89.      1)  the model material
  90.      2)  the model paint and/or color
  91.      3)  the original cost
  92.      4)  the current location of the model
  93.      5)  the current appraised value of the model
  94.      6)  the prototype manufacturer
  95.      7)  the prototype model which the model represents
  96.      8)  the prototype railroad for the piece of equipment
  97.      9)  the road number assigned to the prototype equipment
  98.     10)  a note field containing up to 180 characters.
  99.  
  100.  
  101.  
  102. TRAINTRAX is a relational database.  Any information you enter in either
  103. the STANDARD or the DELUXE level is accessible in the other level.  You
  104. can start off with the STANDARD level now.  If you later decide to go to
  105. the DELUXE level, you don't have to reenter the information.  Simply pull
  106. up the equipment record in the DELUXE level option and edit it by adding
  107. the additional information.  You can use the STANDARD level view/update and
  108. print options with DELUXE level records.  Likewise, you can use any of the
  109. DELUXE level view/update or print options with STANDARD level records.
  110. However, to make full use of the DELUXE level features, you should complete
  111. as many of the fields on the Deluxe level entry form as possible.
  112. III.  ENTERING YOUR MODEL RAILROAD EQUIPMENT INFORMATION
  113.  
  114.      A)  Highlight the option VIEW/UPDATE EQUIPMENT ROSTER on the Main menu
  115. and press ENTER to select.  Highlight the STANDARD or DELUXE level option and
  116. press ENTER.
  117.  
  118.          On the STANDARD level menu, you will see the following options:
  119.               View equipment by Model Railroad Name
  120.                                       Equipment Category-Type
  121.               Print STANDARD Level Roster
  122.  
  123.          On the DELUXE level menu, you will see the following options:
  124.               View equipment by MODEL     Category-Type
  125.                                           Roadname and Number
  126.                                           Scale
  127.                                           Manufacturer
  128.               View equipment by PROTOTYPE Category-Type
  129.                                           Roadname and Number
  130.  
  131.  
  132.  
  133.  
  134.  
  135.      B)  Select any of the "View Equipment" options (Highlight & press ENTER).
  136. Since there will be no records in the file the first time you use TRAINTRAX,
  137. you will go immediately to the Enter Record Information Screen.  You MUST
  138. enter information into every field shown on the STANDARD level screen.  These
  139. are the first six fields shown on the DELUXE level screen (above the thin
  140. horizonal line):
  141.  
  142.          1) Equipment Category-Type:  the entry for this field must first be
  143.             entered in the Equipment Category-Type table before you can enter
  144.             it here.  Type the information EXACTLY as it appears in the
  145.             Equipment Category-Type table or press ENTER to "pop-up" the
  146.             table, then highlight the correct category-type & press ENTER to
  147.             "import" the information to the Category-Type field of the record
  148.             information form. (See Section V on the LOOK UP TABLES.)
  149.  
  150.          2) Scale:  Enter the scale for the piece of model railroad equipment
  151.             being entered.  As with the equipment category-type, the scale
  152.             information MUST be entered into the SCALE table before it can be
  153.             entered here.  Once entered into the Scale table, highlight and
  154.             press ENTER to select, or type the correct information as it
  155.             appears in the table.   This table will "pop-up" if you press
  156.             ENTER while the scale field is highlighted on the screen.
  157.             Highlight the correct scale information and press ENTER to import
  158.             it to the record information screen.  (See Section V on the LOOK
  159.             UP TABLES.)
  160.  
  161.          3) Model Manufacturer:  Enter the company who built the model.  EG:
  162.             Tyco, Walthers, Model Die Casting, Bowser, Kato, etc.  If the
  163.             model is scratchbuilt, use that (or a similar) term here.
  164.  
  165.          4) Model:  enter the model name or number as it was built by the
  166.             model manufacturer.  If it was a diesel engine, model FA and you
  167.             modified it to resemble a FA2, you should still enter the
  168.             original FA here.
  169.  
  170.          5) Model Railroad:  Enter the railroad which the model is painted
  171.             and lettered for.  (If the piece was originally lettered for
  172.             the Sante Fe, and you repainted and relettered it for the
  173.             Pennsylvania Railroad, enter Pennsylvania here.)  As with
  174.             Equipment Category-Type and Scale, there is also a table for
  175.             Railroad name and reporting marks which you MUST have the correct
  176.             railroad information entered into first.  Note that the
  177.             information entered in the field on the record information screen
  178.             is actually the railroad reporting marks.  The proper railroad
  179.             information can be imported to the record information screen in
  180.             the same manner as the other two "pop-up" tables noted above.
  181.             (See Section V on the LOOK UP TABLES.)
  182.  
  183.          6) Model Railroad Number:  Enter the equipment roadnumber printed on
  184.             the model.
  185.  
  186.  
  187.      The following information can also be entered for the Deluxe level.
  188. This information is not required, but completeing these fields will allow
  189. you to use more of the Deluxe level features:
  190.  
  191.          7) Material:  What the model is made of (brass, plastic, wood, etc).
  192.          8) Paint/Color:  The paint scheme or color(s) used on the model.
  193.          9) Cost:  What you paid for the model.
  194.         10) Location:  Use this when your model is "visiting" someone else's
  195.             "pike".
  196.  
  197.  
  198.  
  199.  
  200.         11) Current Value:  The current appraised value of your model (used
  201.             with expensive models for insurance purposes).
  202.         12) Prototype Manufacturer:  Who built the actual prototype for your
  203.             model.
  204.         13) Prototype Model:  What prototype model does your model represent.
  205.         14) Prototype Railroad:  The reporting marks for the prototype
  206.             railroad.  This information must be entered into the Railroad
  207.             Name look up table first, just as the model railroad name.  To
  208.             access this look up table, press the F-2 key.
  209.         15) Prototype Railroad Number:  The road number on the prototype.
  210.         16) Notes:  Any other information you wish to add in reference to
  211.             this model.
  212.  
  213.      NOTE: pressing the F-1 (help) key while the entry form is on the screen
  214. will provide on-line information as to what is entered into each field.
  215.  
  216.      The information you have entered for this equipment record will
  217. automatically be saved when you press the ENTER key to complete the last
  218. field.  If you are not going to complete all of the DELUXE level fields, you
  219. can press the F-10 Key to save the information you have already entered.
  220. After saving the record, the program will automatically go to the VIEW
  221. EQUIPMENT table for the option you originally chose.  To enter another
  222. equipment record, press the INSERT key and fill in the information as noted
  223. above.
  224.  
  225.  
  226. IV.  VIEWING YOUR MODEL RAILROAD INFORMATION
  227.  
  228.      After you have entered some equipment records, you can view them...
  229.  
  230. (STANDARD level) in alphabetical order by the Model Railroad Name or by the
  231. Equipment Category-Type.
  232.  
  233. (DELUXE level) in alphabetical order by Model Category-Type, Model Railroad
  234. Name, Model Scale, Model Manufacturer, Prototype Category-Type, or Prototype
  235. Railroad Name.
  236.  
  237. (Note: After you have entered a large number of records, the program may take
  238. several seconds to switch from one viewing option to another.)
  239.  
  240.      While in any viewing options, you can select to:
  241.  
  242.          1) ENTER A NEW RECORD by pressing the INSERT key and completing the
  243.                 equipment information.
  244.  
  245.          2) EDIT AN EXISTING RECORD by highlighting the record and pressing
  246.                 the ENTER key.  Then go to the field(s) you wish to change,
  247.                 enter the corrected information and press the ENTER key to go
  248.                 to the next field.  After editing the field(s), you can press
  249.                 the CONTROL and ENTER keys together to save the edited record
  250.                 and exit to the current viewing option.
  251.  
  252.          3) DELETE AN EXISTING RECORD by highlighting the record and pressing
  253.                 the DELETE key. The selected record will then be displayed on
  254.                 the screen. To delete it, press the ENTER key.  To abort the
  255.                 delete, press the ESCAPE key.   Use caution with the delete
  256.                 option.  Once you have deleted a record, you CANNOT recover
  257.                 it.  In case of an accidental deletion, you must enter the
  258.                 record completely as a new record.
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.          4) PRINT A RECORD by highlighting the record and pressing the ENTER
  267.                 key.  When the correct record is displayed on the screen,
  268.                 press the F-5 key to print a copy to your printer.
  269.  
  270.  
  271.  
  272. V.   VIEWING/UPDATING THE LOOK UP TABLES
  273.  
  274.      The TRAINTRAX program uses look up or "pop up" tables to assist you in
  275. maintaining continuity in entering certain information.  These tables are
  276. provided for the EQUIPMENT CATEGORY-TYPE (both model and prototype),  the
  277. MODEL SCALE, and the RAILROAD NAME & REPORTING MARKS (both model and
  278. prototype).  The required information must be entered into each of these look
  279. up tables before it can be entered into the equipment record entry form.
  280.  
  281.      Select the individual look up table from the main menu.  As with the
  282. equipment viewing tables noted in Section III, the information entry form
  283. will be automatically displayed the first time you access each table.  Simply
  284. enter the information into the appropriate field(s) of each form.  All of the
  285. information is required.
  286.  
  287.      1) EQUIPMENT CATEGORY-TYPE:  You can enter what ever categories/types
  288.         you wish.   (Specific examples might be "Engine-Steam, Engine-Diesel,
  289.         Freight Car-Box, Passenger Car-Coach, Maintenance-Snowplow".)
  290.  
  291.      2) MODEL SCALE: Enter the Scales (O, HO, N, ETC.) which you will use.
  292.  
  293.      3) RAILROAD NAMES AND REPORTING MARKS:  Enter the full name of the
  294.         railroad and the reporting marks which it uses.
  295.  
  296.      You can also View, Edit, or Delete the information in the look up tables
  297. the same as you can with the equipment tables (Highlight and press ENTER to
  298. view or edit. Highlight and press DELETE to delete.).
  299.  
  300.      On-line help for these look up tables is available by pressing F-1.
  301. (The Help screens can not be viewed if the information entry form is on the
  302. screen.)
  303.  
  304.  
  305. VI.  PRINTING OPTIONS FOR REPORTS/LISTINGS
  306.  
  307.      You can print reports in either the Standard or Deluxe levels.  These
  308. listings are very similar in appearance.
  309.  
  310.         The Standard level options are accessed by selecting View/Update
  311.         EQUIPMENT ROSTER on the Main Menu, then selecting STANDARD level,
  312.         and then select PRINT STANDARD LEVEL ROSTER.  The Standard Roster
  313.         options are to print the entire data file (all the records entered)
  314.         in alphabetical order by either Category-Type or Model Railroad Name.
  315.  
  316.         The Deluxe level options are accessed by selecting PRINT DELUXE LEVEL
  317.         ROSTERS on the Main Menu.  You can then print an alphabetical listing
  318.         of all the records by Category-Type or Model Railroad Name or print
  319.         only records for a SELECTED Category-Type or Model Railroad Name
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332. SHAREWARE Policy and User Registration:
  333.  
  334. The concept of SHAREWARE is to try a program BEFORE you by it.  If you like
  335. the program and continue to use it beyond a specified period of time, you are
  336. obligated to register your copy with the author.  Since the registration fee
  337. involved is usually small when compared to comparable commercial programs,
  338. you can receive quality programs at very reasonable costs.  Your registration
  339. fee also supports the program authors and encourages them to produce more
  340. quality products.
  341.  
  342.  
  343. TRAINTRAX is distributed as SHAREWARE.  You are allowed to use this program
  344. free of cost for a 21 day trial period.  You must register (or license) the
  345. program if you continue to use it beyond this trial period.   During the
  346. SHAREWARE trial period, you may freely copy and distribute this program;
  347. provided that the program is intact and in its original form (including all
  348. SHAREWARE notices), and that no fee is charged for this distribution.
  349. Approved SHAREWARE vendors may charge a nominal fee to cover their costs of
  350. distribution.  SHAREWARE vendors may also include other documentation and/or
  351. files on the disk with this program, as long as no TRAINTRAX program files
  352. are deleted or modified.
  353.  
  354. This program is copyrighted, Neither the SHAREWARE version nor the REGISTERED
  355. version may be modified in any way without the author's prior written
  356. consent.
  357.  
  358. On submitting the required $20 (US) registration fee, the author will send
  359. you a REGISTERED version of this model railroad equipment Catalog.  This
  360. REGISTERED version will contain the owner's name in the main menu screen.
  361. You are allowed to make a back up copy of this REGISTERED version, but MAY
  362. NOT distribute copies of it to others.
  363.  
  364.  
  365. To print the REGISTRATION FORM....
  366. press the F-5 key on the Main Menu Screen. Fill in the requested information
  367. and send with a check or money order in the required amount to the address
  368. shown on the opening Menu screen.   Be sure to note the proper disk size for
  369. your system  (double density 5 1/4 or 3 1/2).  Also enter the name of your
  370. model railroad if you wish this to be shown with your name on the opening
  371. Menu screen. If you are a member of the National Model Railroad Association,
  372. please enter your NMRA member number on the form.
  373.  
  374.                                    THANK YOU
  375. ----------------------------------------------------------------------------